<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookUtility</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">

<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<h1 class="unit">Unit BrookUtility</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Uses">Uses</a></div><div class="one_section"><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></div><div class="one_section">Functions and Procedures</div><div class="one_section"><a class="section" href="#PasDoc-Types">Types</a></div><div class="one_section"><a class="section" href="#PasDoc-Constants">Constants</a></div><div class="one_section">Variables</div></div>
<span id="PasDoc-Description"></span><h2 class="description">Description</h2>
<p>
Utility functions of the framework.</p>
<span id="PasDoc-Uses"></span><h2 class="uses">Uses</h2>
<ul class="useslist"><li>RTLConsts</li><li>SysUtils</li><li>DateUtils</li><li>Classes</li><li>TypInfo</li><li>SyncObjs</li><li>SHA1</li><li>HttpProtocol</li><li>Marshalling</li><li>libsagui</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Classes"></span><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="BrookUtility.TBrookLocker.html"><code>TBrookLocker</code></a></td>
<td class="itemdesc">Allows to <a class="normal" href="BrookUtility.TBrookLocker.html#Lock">lock</a> other threads from accessing a block of code.</td>
</tr>
<tr class="list2">
<td class="itemname">Record&nbsp;<a class="bold" href="BrookUtility.Sagui.html"><code>Sagui</code></a></td>
<td class="itemdesc">Global <code>Sagui</code> object containing general purpose functions.</td>
</tr>
<tr class="list">
<td class="itemname">Record&nbsp;<a class="bold" href="BrookUtility.Brook.html"><code>Brook</code></a></td>
<td class="itemdesc">Global <code>Brook</code> object containing general purpose functions.</td>
</tr>
<tr class="list2">
<td class="itemname">Record&nbsp;<a class="bold" href="BrookUtility.TBrookHTTPRequestMethodHelper.html"><code>TBrookHTTPRequestMethodHelper</code></a></td>
<td class="itemdesc">Type helper for HTTP verb conversion.</td>
</tr>
</table>
<span id="PasDoc-Types"></span><h3 class="summary">Types</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><strong><a href="BrookUtility.html#TBrookErrorEvent">TBrookErrorEvent</a></strong> = procedure(ASender: TObject; AException: Exception) of object;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><strong><a href="BrookUtility.html#TBrookHTTPRequestMethod">TBrookHTTPRequestMethod</a></strong> = (...);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><strong><a href="BrookUtility.html#TBrookHTTPRequestMethods">TBrookHTTPRequestMethods</a></strong> = set of <a href="BrookUtility.html#TBrookHTTPRequestMethod">TBrookHTTPRequestMethod</a>;</code></td>
</tr>
</table>
<span id="PasDoc-Constants"></span><h3 class="summary">Constants</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><strong><a href="BrookUtility.html#tkPrimitives">tkPrimitives</a></strong> = tkProperties -

    [tkArray..tkObject] - [tkInterfaceRaw] - [tkProcVar] - [tkHelper..tkPointer]
;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="TBrookErrorEvent"></span><code><strong>TBrookErrorEvent</strong> = procedure(ASender: TObject; AException: Exception) of object;</code></td>
</tr>
<tr><td colspan="1">
<p>
Event signature used by stuff that handles errors.  </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASender[in]</dt>
<dd>Sender object.</dd>
<dt>AException[in]</dt>
<dd>Exception object.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="TBrookHTTPRequestMethod"></span><code><strong>TBrookHTTPRequestMethod</strong> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
HTTP verbs enumeration.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
<span id="rmUnknown">rmUnknown</span></li>
<li>
<span id="rmGET">rmGET</span></li>
<li>
<span id="rmPOST">rmPOST</span></li>
<li>
<span id="rmPUT">rmPUT</span></li>
<li>
<span id="rmDELETE">rmDELETE</span></li>
<li>
<span id="rmPATCH">rmPATCH</span></li>
<li>
<span id="rmOPTIONS">rmOPTIONS</span></li>
<li>
<span id="rmHEAD">rmHEAD</span></li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="TBrookHTTPRequestMethods"></span><code><strong>TBrookHTTPRequestMethods</strong> = set of <a href="BrookUtility.html#TBrookHTTPRequestMethod">TBrookHTTPRequestMethod</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Set of HTTP verbs.</p>
</td></tr>
</table>
<h3 class="detail">Constants</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="tkPrimitives"></span><code><strong>tkPrimitives</strong> = tkProperties -

    [tkArray..tkObject] - [tkInterfaceRaw] - [tkProcVar] - [tkHelper..tkPointer]
;</code></td>
</tr>
<tr><td colspan="1">
<p>
Primitive kinds.</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>
